﻿#region Header
// ------------------------ Licence / Copyright ------------------------
// 
// ScrumTable for Scrum Meeting Support
// Copyright © HSR - Hochschule für Technik Rapperswil
// All Rights Reserved
// 
// Author:
//  Michael Gfeller Silvan Gehrig Patrick Boos
// 
// ---------------------------------------------------------------------
#endregion

#region Usings

using System.Collections.Generic;
using ScrumTable.DL.Data.Schema.Serialization;

#endregion

namespace ScrumTable.DL.Data.Common.Config.Schema
{
    /// <summary>
    /// Represents the schema source which is used to create new ScrumTableSchema
    /// instances. You should use the IDataSchemaSelector instance in order to
    /// pick the appropriate schema XML source.
    /// </summary>
    public interface IDataSchemaSource
    {
        #region Properties
        //--------------------------------------------------------------------
        // Properties
        //--------------------------------------------------------------------

        /// <summary>
        /// Gets the name of the schema source. This property contains
        /// human readable information about the driver in order to select
        /// the appropriate schema source.
        /// </summary>
        string Name { get; }

        /// <summary>
        /// Gets a list of legacy names for the current data source.
        /// </summary>
        IEnumerable<string> LegacyNames { get; }

        /// <summary>
        /// Gets the deserialized data schema data object which needs to
        /// be loaded into the schema tree.
        /// </summary>
        SchemataRoot SourceData { get; }

        #endregion

        #region Methods
        //--------------------------------------------------------------------
        // Methods
        //--------------------------------------------------------------------

        #endregion

        #region Events

        //--------------------------------------------------------------------
        // Events
        //--------------------------------------------------------------------

        #endregion
    }
}